Carbon


DrawThemeScrollBarDelimiters

Header: Appearance.h Carbon status: Supported

Outlines a window’s scroll bars.

OSStatus DrawThemeScrollBarDelimiters (
    ThemeWindowType flavor, 
    const Rect *inContRect, 
    ThemeDrawState state, 
    ThemeWindowAttributes attributes
);
flavor

A value of type ThemeWindowType. Pass a constant specifying the type of window for which to draw scroll bar delimiters. See “Theme Window Type Constants” for descriptions of possible values.

inContRect

A pointer to a structure of type Rect. Before calling DrawThemeScrollBarDelimiters, set the rectangle to the boundary of the content rectangle of the window, in local coordinates.

state

A value of type ThemeDrawState. Pass a constant—either kThemeStateActive or kThemeStateInactive—appropriate to the current state of the window. The scroll bar delimiters can be drawn as active or inactive; passing kThemeStatePressed produces an error. See “Theme Draw State Constants” for descriptions of these values.

attributes

A value of type ThemeWindowAttributes. Pass one or more constants corresponding to the window’s current visual attributes. See “Theme Window Attribute Constants” for descriptions of possible values. Pass 0 if the window has none of the enumerated attributes.

function result

A result code.

DISCUSSION

The DrawThemeScrollBarDelimiters function draws theme-compliant outlines for both the horizontal and vertical scroll bars in a given window. The scroll bars are each assumed to cover the full length of their respective sides of the window’s content region; if the scroll bars for which you wish delimiters to be drawn are not full length, or if only one scroll bar exists for a given window, DrawThemeScrollBarDelimiters should not be used.

VERSION NOTES

This function is available with Appearance Manager 1.1 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)